Skip to main content
Feedback

Configuring API Endpoint Domains & Traffic Routing Settings

The API Endpoint Settings: <your endpoint name> page on the Domain & Traffic Routing tab lists the configured HTTPS Client Profiles created in Cloud API Management and Local Edition.

On this page, you can configure Domains & Traffic Routing settings to edit an existing endpoint definition. You can modify the name, Public endpoint address, and Traffic Manager endpoint address on this page. Note that if enhanced security is enabled while creating the endpoint, the respective field is not displayed on this page. Hence, once enabled, the enhanced security for that endpoint cannot be disabled.

Procedure

  1. On the Get Started page, click API Definitions.

    Or

    Navigate to Design > APIs. This opens the Manage your APIs with API Definitions page.

  2. In the Name column, click the API definition link to open the Endpoints:<your api name> page.

  3. In the Action column, click the Settings icon of an endpoint for which you want to configure endpoint settings. This opens the API Endpoint Settings: <your endpoint name> page on the Domain &Traffic Routing tab.

  4. In Name, specify the endpoint name. This endpoint name is reflected wherever this endpoint is mentioned.

  5. In Require Enhanced Security, enable or disable the toggle switch to specify whether an SSL certificate is required for the endpoint.

    If enabled, all calls to this endpoint use SSL. If this setting is unavailable, contact the Boomi Account representative via Boomi Community to enable it.

    note

    • This field restricts the use of http for public and backend endpoints.

    • After enabling this field, the Customize your Public Endpoint Address and Your Endpoint Address fields (transport protocol field) will be modified to https for both public and backend endpoints. Once enabled, it cannot be modified to http or other protocols.

    • This field is not displayed if enabled while creating the endpoint. In other words, this field cannot be edited after the endpoint is created.

  6. In Require Mutual TLS(mTLS), enable or disable the toggle switch to specify whether an mTLS certificate is required for the endpoint. If enabled, all calls to this endpoint use mTLS.

    note

    • This field restricts the use of http for public and backend endpoints.

    • After enabling this field, the Customize your Public Endpoint Address field will be modified to https for the public endpoint. Once enabled, it cannot be modified to http or other protocols.

    • This setting is supported only in Cloud API Management - Local Edition 5.3 and later versions.

    • This field is available only if a feature flag is enabled for your area. If it is unavailable, the feature flag is likely disabled for your area.

  7. In Customize your Public Endpoint Address, specify the public domain name and path for the endpoint. Developers use this path to make API calls for an endpoint using curl or other applications. The value specified here appears at the top of the page under Your Public Endpoint Domain.

    note

    You must add only the allowed listed domain address in this field. The status of the allowed list of public domain names is available on the View and manage domains for APIs page. To view and request new public endpoint domains, click the Manage Domains link.

  8. In Your Endpoint Address, specify the backend domain name and path for the API call that will be sent to the backend endpoint system that contains your data. If needed, you can pass in query parameters to your Endpoint system.

    note

    The domain address specified here does not need to be allow-listed. For GRAPHQL endpoint types, this field is read-only. However, for REST, SOAP, JSON-RPC, XML-RPC, and OTHER endpoint types, it is configurable.

  9. In Select HTTPS Client Profile, select the HTTPS Profile configured in Cloud API Management or Local Edition. Refer to Creating an HTTPS Client Profile in Cloud API Management and Creating an API HTTPS Client Profiles in Local Edition for more information.

  10. In Your Public Traffic Manager Domain, click Edit to modify the Cloud API Management internal hostname (domain name) to which the requested public domain name is CNAMED.

    important

    Consult the Boomi Account representative via Boomi Community before editing the Cloud API Management internal domain name.

  11. In Your Endpoint Domain, specify the URI path of the host server that the Traffic Manager uses to send an API call. The Traffic Manager performs call logging and applies the configured rules before sending an API call.

    note

    This field is available when the endpoint is manually configured.

  12. Click Save

On this Page